Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed Spanish description for all 2D Primitive Functions in p5js.org Reference #1402

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

OnexiMedina
Copy link
Contributor

Addresses #1225

Changes:

I fixed the Spanish [ES] description of all the functions() under 2D Primitives in the Reference for p5js.org. The descriptions had different descriptions than the English version, had missing links for functions mentioned in the descriptions, or were previously half-English and half-Spanish.

Similar to what was mentioned in my previous pull request ( #1400 ), here are my specific changes:

  • The English descriptions and Spanish descriptions contained different information for some functions. Therefore, I proceeded to make a direct translation of the English description as the first paragraph of the new Spanish translation, and formatted the additional information, found in the current Spanish description, under it. This was to bring consistency of formatting with the original English version, while also respecting the additional information previous contributors added to the Spanish version.
  • I added working links to functions that were referenced in the descriptions. (See images for arc() and circle() as examples)
  • Highlighted mentioned parameters for easier visibility

Below I have added screenshots for the current Spanish descriptions and the new Spanish descriptions (for future reference and documentation purposes). Hope this helps!

Screenshots of the change:

arc()

Current:

Screenshot 2023-08-04 at 2 43 17 PM

New:

Screenshot 2023-08-04 at 2 43 39 PM

ellipse()

Current:

Screenshot 2023-08-04 at 2 44 19 PM

New:

Screenshot 2023-08-04 at 2 44 36 PM

circle()

Current:

Screenshot 2023-08-04 at 2 45 50 PM

New:

Screenshot 2023-08-04 at 2 46 17 PM

line()

Current:

Screenshot 2023-08-04 at 2 46 47 PM

New:

Screenshot 2023-08-04 at 2 47 18 PM

point()

Current:

Screenshot 2023-08-04 at 2 47 52 PM

New:

Screenshot 2023-08-04 at 2 48 12 PM

quad()

Current:

Screenshot 2023-08-04 at 2 48 47 PM

New:

Screenshot 2023-08-04 at 2 49 07 PM

rect()

Current:

Screenshot 2023-08-04 at 2 49 52 PM

New:

Screenshot 2023-08-04 at 2 50 13 PM

square()

Current:

Screenshot 2023-08-04 at 2 50 46 PM

New:

Screenshot 2023-08-04 at 2 51 38 PM

triangle()

Current:

Screenshot 2023-08-04 at 2 52 02 PM

New:

Screenshot 2023-08-04 at 2 52 22 PM

@Qianqianye
Copy link
Contributor

Thanks @OnexiMedina! Our technical writer @nickmcintyre is updating the reference documentation. We are working on the English version first, then we will update the translations later. @nickmcintyre, can you confirm if the 2D primitive reference in this PR is most updated? Thanks.
Meanwhile, I'm tagging the Spanish translation stewards to review the PR @Guirdo, @Andreu-G, @dnd-alv, @holomorfo

@nickmcintyre
Copy link
Member

@Qianqianye @OnexiMedina thanks for inviting me to the discussion. The different versions of our documentation should probably stay in sync when possible. I suggest we open dedicated issues for revising the English content first. I made the first batch of edits quickly to get things started, and I'm happy to revise them based on your feedback. Looking back, some of them definitely need more work.

@OnexiMedina thanks for putting so much care and consideration into the translations. The main goal is to make the documentation more beginner-friendly. In practice, that's meant using plain language (sixth grade level) and simplifying wherever possible. Lots of things need to be rewritten and you're welcome to help steer that effort.

@Qianqianye
Copy link
Contributor

Thanks @nickmcintyre. We can pause the translation effort for now and revisit this issue after this year's Season of Doc technical writer program when the English version is updated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants